🎖️GitЯра🎖️
Node / meshtastic / Meshtastic-Android / files / core / konsist / src / jvmTest / kotlin / org / meshtastic / core / konsist / BleAddressLoggingTest.kt
Displaying Raw • Download
core/konsist/src/jvmTest/kotlin/org/meshtastic/core/konsist/BleAddressLoggingTest.kt bd2863243bab6eb213401d949839a2bc74dde7e2 (bd286324) Text, 5.38 KB
T8b949e/*
* Copyright (c) 2026 Meshtastic LLC
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
Tff7b72package T7ee787org.meshtastic.core.konsist
Tff7b72import T7ee787com.lemonappdev.konsist.api.Konsist
Tff7b72import T7ee787kotlin.test.Test
Tff7b72import T7ee787kotlin.test.assertTrue
T8b949e/**
* A BLE MAC address is a stable hardware identifier for the user's radio, and Kermit forwards every `Logger` call to
* Datadog and Crashlytics on analytics the user is opted into by default. So an address must never be interpolated into
* log or exception text raw — it goes through `Any?.anonymize()`, which keeps only a short suffix.
*
* This is enforced as an architecture rule rather than by review because the failure mode is missing a site: a previous
* attempt anonymised the hand-written log statements in `core/ble` and missed the Kable `identifier`, which stamps the
* address onto *every* line the BLE library emits, plus further sites in the DFU transports and WiFi provisioning.
*
* Scoped to the BLE-adjacent modules so matching on the `address` suffix stays low-noise.
*/
Tff7b72class T56d364BleAddressLoggingTest Tb4b4b4{
Tff7b72private Tff7b72val Te6edf3scannedPathFragments Tff7b72=
Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ff/core/ble/Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff/feature/firmware/Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff/feature/wifi-provision/Ta5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ff/feature/connections/Ta5d6ff"Tb4b4b4)
T8b949e/**
* Files where an address is used as an identity rather than as diagnostic text — building the connection string or
* a device label the user themselves is looking at. Anonymising these would break functionality.
*/
Tff7b72private Tff7b72val Te6edf3identityUseAllowlist Tff7b72= Te6edf3listOfTb4b4b4(Ta5d6ff"Ta5d6ffDeviceListEntry.ktTa5d6ff"Tb4b4b4)
T8b949e/** Interpolation of anything ending in `address`, e.g. `${device.address}` or `$address`. */
Tff7b72private Tff7b72val Te6edf3interpolatedAddress Tff7b72= Te6edf3RegexTb4b4b4(Ta5d6ff"""Ta5d6ff\$Ta5d6ff\Ta5d6ff{?[A-Za-z0-9_.]*[aA]ddress}?Ta5d6ff"""Tb4b4b4)
T8b949e/**
* Files this rule covers.
*
* Extracted and asserted non-empty by [the scan actually reaches the BLE sources] because a rule whose scope
* silently matches nothing passes for the wrong reason — which is the whole failure mode this test exists to catch.
*/
Tff7b72private Tff7b72fun Td2a8ffscannedFilesTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3KonsistTb4b4b4.Te6edf3scopeFromProjectTb4b4b4(Tb4b4b4)
Tb4b4b4.Te6edf3files
Tb4b4b4.Te6edf3filterNot Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3isNestedAgentWorktreeTb4b4b4(Tb4b4b4) Tb4b4b4}
Tb4b4b4.Te6edf3filter Tb4b4b4{ Te6edf3file Tff7b72-Tff7b72> Te6edf3scannedPathFragmentsTb4b4b4.Te6edf3any Tb4b4b4{ Tffa657it Tff7b72in Te6edf3fileTb4b4b4.Te6edf3scanPath Tb4b4b4} Tb4b4b4}
Tb4b4b4.Te6edf3filterNot Tb4b4b4{ Te6edf3file Tff7b72-Tff7b72> Te6edf3identityUseAllowlistTb4b4b4.Te6edf3any Tb4b4b4{ Te6edf3fileTb4b4b4.Te6edf3scanPathTb4b4b4.Te6edf3endsWithTb4b4b4(Tffa657itTb4b4b4) Tb4b4b4} Tb4b4b4}
Tf0883e@Test
Tff7b72fun Td2a8ff`the scan actually reaches the BLE sources`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3paths Tff7b72= Te6edf3scannedFilesTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3map Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3scanPath Tb4b4b4}
Te6edf3assertTrueTb4b4b4(Te6edf3pathsTb4b4b4.Te6edf3isNotEmptyTb4b4b4(Tb4b4b4)Tb4b4b4, Te6edf3emptyScanMessageTb4b4b4(Ta5d6ff"Ta5d6ffBLE-scoped scanTa5d6ff"Tb4b4b4)Tb4b4b4)
Te6edf3assertTrueTb4b4b4(
Te6edf3pathsTb4b4b4.Te6edf3any Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3endsWithTb4b4b4(Ta5d6ff"Ta5d6ffKableBleConnection.ktTa5d6ff"Tb4b4b4) Tb4b4b4}Tb4b4b4,
Ta5d6ff"Ta5d6ffexpected core/ble sources in scope; got Tffd700${Te6edf3pathsTb4b4b4.Te6edf3sizeTffd700}Ta5d6ff files, e.g. Tffd700${Te6edf3pathsTb4b4b4.Te6edf3takeTb4b4b4(T79c0ff3Tb4b4b4)Tffd700}Ta5d6ff"Tb4b4b4,
Tb4b4b4)
Tb4b4b4}
Tf0883e@Test
Tff7b72fun Td2a8ff`a BLE address is never interpolated into log or exception text without anonymize`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3offenders Tff7b72=
Te6edf3scannedFilesTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3flatMap Tb4b4b4{ Te6edf3file Tff7b72-Tff7b72>
Te6edf3fileTb4b4b4.Te6edf3textTb4b4b4.Te6edf3linesTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3withIndexTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3mapNotNull Tb4b4b4{ Tb4b4b4(Te6edf3indexTb4b4b4, Te6edf3lineTb4b4b4) Tff7b72-Tff7b72>
Tff7b72val Te6edf3isDiagnostic Tff7b72= Ta5d6ff"Ta5d6ffLogger.Ta5d6ff" Tff7b72in Te6edf3line Tff7b72|Tff7b72| Ta5d6ff"Ta5d6ffthrow Ta5d6ff" Tff7b72in Te6edf3line Tff7b72|Tff7b72| Ta5d6ff"Ta5d6ffcheck(Ta5d6ff" Tff7b72in Te6edf3line Tff7b72|Tff7b72| Ta5d6ff"Ta5d6ffrequire(Ta5d6ff" Tff7b72in Te6edf3line
Tff7b72val Te6edf3interpolates Tff7b72= Te6edf3interpolatedAddressTb4b4b4.Te6edf3containsMatchInTb4b4b4(Te6edf3lineTb4b4b4)
Tff7b72val Te6edf3anonymised Tff7b72= Ta5d6ff"Ta5d6ffanonymizeTa5d6ff" Tff7b72in Te6edf3line
Tff7b72if Tb4b4b4(Te6edf3isDiagnostic Tff7b72&Tff7b72& Te6edf3interpolates Tff7b72&Tff7b72& Tff7b72!Te6edf3anonymisedTb4b4b4) Tb4b4b4{
Ta5d6ff"Tffd700${Te6edf3fileTb4b4b4.Te6edf3scanPathTb4b4b4.Te6edf3substringAfterLastTb4b4b4(Ta5d6ff"Tff7b72/Te6edf3kotlinTff7b72/Ta5d6ff"Tb4b4b4)Tffd700}Ta5d6ff:Tffd700${Te6edf3index Tff7b72+ T79c0ff1Tffd700}Ta5d6ff: Ta5d6ff" Tff7b72+ Te6edf3lineTb4b4b4.Te6edf3trimTb4b4b4(Tb4b4b4)
Tb4b4b4} Tff7b72else Tb4b4b4{
Tff7b72null
Tb4b4b4}
Tb4b4b4}
Tb4b4b4}
Te6edf3assertTrueTb4b4b4(
Te6edf3offendersTb4b4b4.Te6edf3isEmptyTb4b4b4(Tb4b4b4)Tb4b4b4,
Ta5d6ff"Ta5d6ffBLE addresses must be anonymised in diagnostic text. Offending lines:Ta5d6ff\Ta5d6ffnTa5d6ff" Tff7b72+ Te6edf3offendersTb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)Tb4b4b4,
Tb4b4b4)
Tb4b4b4}
T8b949e/**
* Kable stamps its `Logging.identifier` onto every line it emits, so passing a raw address there leaks it from
* library-internal logging that no per-call-site review would catch.
*/
Tf0883e@Test
Tff7b72fun Td2a8ff`the Kable logging identifier is never a raw address`Tb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3offenders Tff7b72=
Te6edf3KonsistTb4b4b4.Te6edf3scopeFromProjectTb4b4b4(Tb4b4b4)
Tb4b4b4.Te6edf3files
Tb4b4b4.Te6edf3filterNot Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3isNestedAgentWorktreeTb4b4b4(Tb4b4b4) Tb4b4b4}
Tb4b4b4.Te6edf3filter Tb4b4b4{ Ta5d6ff"Ta5d6ff/core/ble/Ta5d6ff" Tff7b72in Tffa657itTb4b4b4.Te6edf3scanPath Tb4b4b4}
Tb4b4b4.Te6edf3flatMap Tb4b4b4{ Te6edf3file Tff7b72-Tff7b72>
Te6edf3fileTb4b4b4.Te6edf3textTb4b4b4.Te6edf3linesTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3withIndexTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3mapNotNull Tb4b4b4{ Tb4b4b4(Te6edf3indexTb4b4b4, Te6edf3lineTb4b4b4) Tff7b72-Tff7b72>
Tff7b72if Tb4b4b4(Ta5d6ff"Ta5d6ffidentifier =Ta5d6ff" Tff7b72in Te6edf3line Tff7b72&Tff7b72& Ta5d6ff"Ta5d6ffaddressTa5d6ff" Tff7b72in Te6edf3line Tff7b72&Tff7b72& Ta5d6ff"Ta5d6ffanonymizeTa5d6ff" Tff7b72!in Te6edf3lineTb4b4b4) Tb4b4b4{
Ta5d6ff"Tffd700${Te6edf3fileTb4b4b4.Te6edf3scanPathTb4b4b4.Te6edf3substringAfterLastTb4b4b4(Ta5d6ff"Tff7b72/Te6edf3kotlinTff7b72/Ta5d6ff"Tb4b4b4)Tffd700}Ta5d6ff:Tffd700${Te6edf3index Tff7b72+ T79c0ff1Tffd700}Ta5d6ff: Ta5d6ff" Tff7b72+ Te6edf3lineTb4b4b4.Te6edf3trimTb4b4b4(Tb4b4b4)
Tb4b4b4} Tff7b72else Tb4b4b4{
Tff7b72null
Tb4b4b4}
Tb4b4b4}
Tb4b4b4}
Te6edf3assertTrueTb4b4b4(
Te6edf3offendersTb4b4b4.Te6edf3isEmptyTb4b4b4(Tb4b4b4)Tb4b4b4,
Ta5d6ff"Ta5d6ffKable's logging identifier must be anonymised. Offending lines:Ta5d6ff\Ta5d6ffnTa5d6ff" Tff7b72+ Te6edf3offendersTb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)Tb4b4b4,
Tb4b4b4)
Tb4b4b4}
Tb4b4b4}
Served by rngit 1.5.0 - Generated in 0.06s